<?php
# MantisBT - A PHP based bugtracking system

# MantisBT is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# MantisBT is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with MantisBT.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Mantis Formatting Plugins
 * @copyright Copyright 2000 - 2002  Kenzaburo Ito - kenito@300baud.org
 * @copyright Copyright 2002  MantisBT Team - mantisbt-dev@lists.sourceforge.net
 * @link http://www.mantisbt.org
 * @package MantisBT
 * @subpackage classes
 */

/**
 * Abstract class for any plugin that's modifying textual output.
 */
abstract class MantisFormattingPlugin extends MantisPlugin
{
    /**
     * Event hook declaration.
     * @return array
     */
    function hooks()
    {
        return array(
            'EVENT_DISPLAY_TEXT' => 'text',            # Text String Display
            'EVENT_DISPLAY_FORMATTED' => 'formatted',        # Formatted String Display
            'EVENT_DISPLAY_RSS' => 'rss',            # RSS String Display
            'EVENT_DISPLAY_EMAIL' => 'email',            # Email String Display
        );
    }

    /**
     * Plain text processing.
     * @param string $p_event Event name.
     * @param string $p_string Un-formatted text.
     * @param boolean $p_multiline Multi-line text.
     * @return string plain text
     */
    function text($p_event, $p_string, $p_multiline = true)
    {
        return $p_string;
    }

    /**
     * Formatted text processing.
     * @param string $p_event Event name.
     * @param string $p_string Un-formatted text.
     * @param boolean $p_multiline Multi-line text.
     * @return string formatted text
     */
    function formatted($p_event, $p_string, $p_multiline = true)
    {
        return $p_string;
    }

    /**
     * RSS text processing.
     * @param string $p_event Event name.
     * @param string $p_string Un-formatted text.
     * @return string Formatted RSS text.
     */
    function rss($p_event, $p_string)
    {
        return $p_string;
    }

    /**
     * Email text processing.
     * @param string $p_event Event name.
     * @param string $p_string Un-formatted text.
     * @return string Formatted email text
     */
    function email($p_event, $p_string)
    {
        return $p_string;
    }
}
